Onboard Intake (1/3): introduce intake runner command #952

yago-123 · 2025-09-03T08:34:33Z

Description

This PR onboards the new STACKIT Intake (ticket) service into the CLI.

Intake is composed of three components:

Intake Runners: dedicated, isolated runtime data ingestion environment
Intakes: a specific data stream or topic within an Intake Runner
Intake Users: provides secure access credentials for your applications to connect to your Intake

This PR contains the Intake Runners part only to make a quicker and less overwhelming review. The remaining code (2/3) can be submitted as part of this PR once the first batch has been reviewed/approved or we can open a different PR for it (as the maintainer please).

The commands are designed to work as follows:

$ stackit-cli intake runner create ... 
$ stackit-cli intake create ... 
$ stackit-cli intake user create...

Most customers will use intakes hence why we decided to go with this command structure. The folder structure will look like the following due to the hierachy desired:

$ ls stackit-cli/internal/cmd/intake
common    
instance    # command for intakes 
intake.go        
runner   
user

Checklist

Issue was linked above
Code format was applied: make fmt
Examples were added / adjusted (see e.g. here)
Docs are up-to-date: make generate-docs (will be checked by CI)
Unit tests got implemented or updated
Unit tests are passing: make test (will be checked by CI)
No linter issues: make lint (will be checked by CI)

yago-123 · 2025-09-03T08:37:23Z

Sample CLI usage:

% ./bin/stackit intake runner create --display-name "runner-example" --max-message-size-kib 1024 --max-messages-per-hour 1000 --project-id xxx
Are you sure you want to create an Intake Runner for project "STACKIT Intake PROD"? [y/N] y
Created Intake Runner for project "STACKIT Intake PROD". Runner ID: yyy

% ./bin/stackit intake runner describe yyy  --project-id xxx                                                 
 
 ATTRIBUTE              │ VALUE                                                                 
────────────────────────┼───────────────────────────────────────────────────────────────────────
 ID                     │ yyy                                  
 Name                   │ runner-example                                                        
 Description            │                                                                       
 Max Message Size (KiB) │ 1024                                                                  
 Max Messages/Hour      │ 1000                                                                  
 Ingestion URI          │ yyy.intake.eu01.onstackit.cloud:9094 
 
% ./bin/stackit intake runner list  --project-id xxx          
 
 ID                                   │ NAME           
──────────────────────────────────────┼────────────────
 aaa  │ testyago       
 bbb │ runner1        
 zzz │ mytestrunner   
 ddd │ runner-example 
 fff │ runner1        
 yyy │ test-yago      
 
% ./bin/stackit intake runner update yyy --display-name runner-updated  --project-id xxx
Update request for Intake Runner "yyy" sent successfully.

% ./bin/stackit intake runner delete yyy  --project-id xxx                           
Are you sure you want to delete Intake Runner "yyy"? [y/N] y
Deletion request for Intake Runner "yyy" sent successfully.

internal/cmd/intake/runner/create/create.go

internal/cmd/intake/runner/delete/delete.go

internal/cmd/intake/runner/list/list.go

internal/cmd/intake/runner/list/list_test.go

internal/cmd/intake/intake.go

internal/cmd/intake/common/util.go

internal/cmd/intake/runner/update/update.go

internal/pkg/config/config.go

yago-123 · 2025-09-15T16:04:43Z

PS: notice that I messed up the branch by mistake, I had to cherry-pick until 7868e56 (last commit reviewed) and force push.

rubenhoenle · 2025-09-19T12:55:43Z

internal/cmd/intake/runner/update/update.go

+				return fmt.Errorf("update Intake Runner: %w", err)
+			}
+
+			p.Printer.Info("Update request for Intake Runner %q sent successfully.\n", model.RunnerId)


This will produce invalid JSON/YAML output in case the --output-format flag is set.

rubenhoenle · 2025-09-19T12:58:03Z

internal/cmd/intake/runner/update/update.go

+				`Update the message capacity limits for an Intake Runner with ID "xxx"`,
+				`$ stackit intake runner update xxx --max-message-size-kib 2000 --max-messages-per-hour 10000`),
+			examples.NewExample(
+				`Clear the labels of an Intake Runner with ID "xxx" by providing an empty value`,


Suggested change

`Clear the labels of an Intake Runner with ID "xxx" by providing an empty value`,

I guess we have to get rid of this example for now, it gives me the following error:

➜ stackit-cli git:(669dbb92) stackit intake runner update xxx --labels "" Error: invalid argument "" for "--labels" flag: must be formatted as key=value exit status 1

This is related to the discussion where I told you we as maintainers of this repo will take care of, sorry for that again 😅

rubenhoenle · 2025-09-19T12:58:27Z

internal/cmd/intake/runner/update/update.go

+	cmd.Flags().Int64(maxMessageSizeKiBFlag, 0, "Maximum message size in KiB. Note: Overall message capacity cannot be decreased.")
+	cmd.Flags().Int64(maxMessagesPerHourFlag, 0, "Maximum number of messages per hour. Note: Overall message capacity cannot be decreased.")
+	cmd.Flags().String(descriptionFlag, "", "Description")
+	cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format. To clear all labels, provide an empty string, e.g. --labels \"\"")


Suggested change

cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format. To clear all labels, provide an empty string, e.g. --labels \"\"")

cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format.")

Edit, maybe better:

Suggested change

cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format. To clear all labels, provide an empty string, e.g. --labels \"\"")

cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format, separated by commas. Example: --labels \"key1=value1,key2=value2\"")

rubenhoenle · 2025-09-19T13:02:01Z

internal/pkg/services/intake/client/client.go

+
+	region := viper.GetString(config.RegionKey)
+	cfgOptions := []sdkConfig.ConfigurationOption{
+		sdkConfig.WithRegion(region),


Please add the header with the CLI version here, like described in our contribution guide:

stackit-cli/.github/docs/contribution-guide/client.go

Line 23 in fa8dea5

utils.UserAgentConfigOption(cliVersion),

rubenhoenle · 2025-09-19T13:02:17Z

internal/pkg/services/intake/client/client.go

+)
+
+// ConfigureClient creates and configures a new Intake API client
+func ConfigureClient(p *print.Printer) (*intake.APIClient, error) {


Suggested change

func ConfigureClient(p *print.Printer) (*intake.APIClient, error) {

func ConfigureClient(p *print.Printer, cliVersion string) (*intake.APIClient, error) {

rubenhoenle · 2025-09-19T13:10:32Z

internal/cmd/intake/runner/delete/delete.go

+				return fmt.Errorf("delete Intake Runner: %w", err)
+			}
+
+			p.Printer.Outputf("Deletion request for Intake Runner %q sent successfully.\n", model.RunnerId)


Same here, invalid JSON/YAML output in case the --output-format flag is set to JSON/YAML.

rubenhoenle · 2025-09-19T13:19:55Z

internal/cmd/intake/runner/update/update.go

+				`$ stackit intake runner update xxx --display-name "new-runner-name"`),
+			examples.NewExample(
+				`Update the message capacity limits for an Intake Runner with ID "xxx"`,
+				`$ stackit intake runner update xxx --max-message-size-kib 2000 --max-messages-per-hour 10000`),


This example produces an error for me:

stackit intake runner update 4db8fc33-22e0-47cd-9574-8615055750f6 --max-message-size-kib 2000 --max-messages-per-hour 10000 Error: update Intake Runner: 400 Bad Request, status code 400, Body: {"message":"invalid maximum message size - should be lower or equal to 1024"} exit status 1

rubenhoenle · 2025-09-19T13:37:14Z

Rest looks good to me. :)

yago-123 requested a review from a team as a code owner September 3, 2025 08:34

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/intake.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/common/util.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/runner/update/update.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/pkg/config/config.go Show resolved Hide resolved

rubenhoenle added the needs-work PR needs work from author. label Sep 4, 2025

yago-123 requested a review from rubenhoenle September 8, 2025 10:57

yago-123 force-pushed the yg/onboard-intake branch from 98373d3 to 732eff1 Compare September 15, 2025 15:04

Yago Carlos Fernandez Gou added 6 commits September 15, 2025 17:14

Onboard Intake (1/3): introduce intake runner command

e9887a4

address review comments

8bc2e14

address review comments: fix listing being empty

a4efb91

address review comments: be able to configure custom endpoints

ecb85c2

update docs

7868e56

remove option for clearing labels

669dbb9

yago-123 force-pushed the yg/onboard-intake branch from 732eff1 to 669dbb9 Compare September 15, 2025 15:21

rubenhoenle approved these changes Sep 19, 2025

View reviewed changes

rubenhoenle reviewed Sep 19, 2025

View reviewed changes

	`Clear the labels of an Intake Runner with ID "xxx" by providing an empty value`,

	cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format. To clear all labels, provide an empty string, e.g. --labels \"\"")
	cmd.Flags().StringToString(labelFlag, nil, "Labels in key=value format.")

	func ConfigureClient(p print.Printer) (intake.APIClient, error) {
	func ConfigureClient(p print.Printer, cliVersion string) (intake.APIClient, error) {

Onboard Intake (1/3): introduce intake runner command #952

Are you sure you want to change the base?

Onboard Intake (1/3): introduce intake runner command #952

Uh oh!

Conversation

yago-123 commented Sep 3, 2025

Description

Checklist

Uh oh!

yago-123 commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yago-123 commented Sep 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rubenhoenle commented Sep 19, 2025

Uh oh!

Uh oh!

yago-123 commented Sep 3, 2025 •

edited

Loading